/**
 * Copyright 2006 gworks.com.au
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License. (http://www.apache.org/licenses/LICENSE-2.0)
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed 
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for 
 * the specific language governing permissions and limitations under the License.
 *
 * <dhamma-message src="Atisha (11th century Tibetan Buddhist master)">
 * 	The greatest achievement is selflessness. The greatest worth is self-mastery.
 * 	The greatest quality is seeking to serve others. The greatest precept is continual awareness.
 * 	The greatest medicine is the emptiness of everything. The greatest action is not conforming with the worlds ways.
 * 	The greatest magic is transmuting the passions. The greatest generosity is non-attachment.
 * 	The greatest goodness is a peaceful mind. The greatest patience is humility.
 * 	The greatest effort is not concerned with results. The greatest meditation is a mind that lets go.
 * 	The greatest wisdom is seeing through appearances. 
 * </dhamma-message>
 */
package org.javaongems.client;

/**
 * <p>Provide the specification for a Gems view</p>
 * <p>Responsibilities:
 * <ul>
 * 	<li>render a visual representation of a model
 * 	<li>accept the signals: hide, refresh and close the view
 * </ul>
 * </p>
 * <p>Collaboratoes:
 * <ul>
 * 	<li> Controllers - who subscribe to most(if not all) the view's widget listeners
 * 	<li> Models - (typically sourced as the results from service invocations)
 * </ul>
 * </p>
 * 
 * @author Ashin Wimalajeewa (ash)
 */
public interface View {
	/**
	 * Query used to get the controller associated with the view.
	 * @return - the controller that is handling all the widget events
	 */
	public Controller getController();
	
	/**
	 * Command used to render the view on the browser's page canvas as a
	 * visual representation.
	 */
	public void show();
	
	/**
	 * Command used to hide the view from the browser's page canvas such
	 * that it is no longer displayed.
	 */
	public void hide();
	
	/**
	 * Command used to force a view to refresh its visual representation.
	 * This may cause the controller to reload the model.
	 */
	public void refresh();
	
	/**
	 * Command which prepares the visual representation for rendering and 
	 * opens dependent resources
	 */
	public void open();
	
	/**
	 * Command used for removing the visual representation and freeing
	 * any resources that it used 
	 */
	public void close();
}
